Extension point queues

In component org.nuxeo.ecm.core.work.service

Documentation

Defines the characteristics of work queues:

    <queue id="myqueue">
        <name>My Queue</name>
        <maxThreads>4</maxThreads>
        <capacity>100</capacity>
        <clearCompletedAfterSeconds>300</clearCompletedAfterSeconds>
        <category>somecategory1</category>
        <category>somecategory2</category>
    </queue>

- id is the queue id.

- name is the human-readable name.

- maxThreads maximum number of worker threads (default 4).

- capacity when specified make the queue bounded, the scheduling of new work is blocking when the queue is full (default unlimited).

- clearCompletedAfterSeconds (default 3600) is the delay after which completed work may be automatically cleared from its queue. 0 means never.

- category is a list of Work categories that this queue will receive. For event listeners work, the category is the listener name (or its simple class name).

Contribution Descriptors

Class: org.nuxeo.ecm.core.work.api.WorkQueueDescriptor

Existing Contributions

Contributions are presented in the same order as the registration order on this extension point. This order is displayed before the contribution name, in brackets.

<extension point="queues" target="org.nuxeo.ecm.core.work.service">
    <queue id="permissionsPurge">
      <maxThreads>1</maxThreads>
      <category>permissionsPurge</category>
    </queue>
  </extension>

(0) nuxeo-admin-center-core-2023.12.6.jar/OSGI-INF/workmanager-contrib.xml Override

<extension point="queues" target="org.nuxeo.ecm.core.work.service">
    <queue id="blobs">
      <maxThreads>2</maxThreads>
      <category>blobListZip</category>
    </queue>
  </extension>

(1) nuxeo-automation-core-2023.12.6.jar/OSGI-INF/workmanager-contrib.xml Override

<extension point="queues" target="org.nuxeo.ecm.core.work.service">
    <queue id="updateACEStatus">
      <maxThreads>1</maxThreads>
      <category>updateACEStatus</category>
    </queue>
  </extension>

(2) nuxeo-core-2023.12.6.jar/OSGI-INF/scheduler-contrib.xml Override

<extension point="queues" target="org.nuxeo.ecm.core.work.service">
    <queue id="computeDigest">
      <maxThreads>2</maxThreads>
      <category>computeDigest</category>
    </queue>
  </extension>

(3) nuxeo-core-2023.12.6.jar/OSGI-INF/asyncdigest-listener-contrib.xml Override

<extension point="queues" target="org.nuxeo.ecm.core.work.service">
    <queue id="transientStorageGC">
      <name>Queue to run Transient Storage Garbage Collection Work</name>
      <maxThreads>1</maxThreads>
      <category>transientStorageGC</category>
    </queue>
  </extension>

(4) nuxeo-core-cache-2023.12.6.jar/OSGI-INF/transientstore-service.xml Override

<extension point="queues" target="org.nuxeo.ecm.core.work.service">
    <queue id="default">
      <name>Default queue</name>
      <maxThreads>4</maxThreads>
      <!-- clear completed work instances older than 10 minutes -->
      <clearCompletedAfterSeconds>600</clearCompletedAfterSeconds>
    </queue>
  </extension>

(5) nuxeo-core-event-2023.12.6.jar/OSGI-INF/workmanager-config.xml Override

<extension point="queues" target="org.nuxeo.ecm.core.work.service">
    <queue id="csvImporter">
      <maxThreads>1</maxThreads>
      <category>csvImporter</category>
    </queue>
  </extension>

(6) nuxeo-csv-core-2023.12.6.jar/OSGI-INF/csv-workmanager-contrib.xml Override

<extension point="queues" target="org.nuxeo.ecm.core.work.service">
    <queue id="elasticSearchIndexing">
      <name>ElasticSearch Indexing</name>
      <maxThreads>4</maxThreads>
      <!-- <usePriority>true</usePriority> -->
      <category>elasticSearchIndexing</category>
      <clearCompletedAfterSeconds>90</clearCompletedAfterSeconds>
    </queue>
  </extension>

(7) nuxeo-elasticsearch-core-2023.12.6.jar/OSGI-INF/workmanager-contrib.xml Override

<extension point="queues" target="org.nuxeo.ecm.core.work.service">
    <queue id="blobProviderDocumentUpdate">
      <maxThreads>2</maxThreads>
      <category>blobProviderDocumentsUpdate</category>
    </queue>
  </extension>

(8) nuxeo-liveconnect-2023.12.6.jar/OSGI-INF/liveconnect-workmanager-contrib.xml Override

<extension point="queues" target="org.nuxeo.ecm.core.work.service">
    <queue id="threeDConversion">
      <maxThreads>1</maxThreads>
      <category>threeDConversion</category>
    </queue>
  </extension>

(9) nuxeo-platform-3d-2023.12.6.jar/OSGI-INF/threed-workmanager-config.xml Override

<extension point="queues" target="org.nuxeo.ecm.core.work.service">
    <queue id="collections">
      <maxThreads>1</maxThreads>
      <category>duplicateCollectionMember</category>
      <category>removedCollectionMember</category>
      <category>removedCollection</category>
      <category>removeFromCollection</category>
    </queue>
  </extension>

(10) nuxeo-platform-collections-core-2023.12.6.jar/OSGI-INF/collection-workmanager-contrib.xml Override

<extension point="queues" target="org.nuxeo.ecm.core.work.service">
    <queue id="pictureViewsGeneration">
      <maxThreads>2</maxThreads>
      <category>pictureViewsGeneration</category>
      <category>pictureViewsGenerationListener</category>
    </queue>
  </extension>

(11) nuxeo-platform-imaging-core-2023.12.6.jar/OSGI-INF/picture-workmanager-contrib.xml Override

<extension point="queues" target="org.nuxeo.ecm.core.work.service">
    <queue id="renditionBuilder">
      <maxThreads>2</maxThreads>
      <category>renditionBuilder</category>
    </queue>
  </extension>

(12) nuxeo-platform-rendition-core-2023.12.6.jar/OSGI-INF/rendition-workmanager-contrib.xml Override

<extension point="queues" target="org.nuxeo.ecm.core.work.service">
    <queue id="videoConversion">
      <maxThreads>2</maxThreads>
      <category>videoConversion</category>
    </queue>
  </extension>

(13) nuxeo-platform-video-2023.12.6.jar/OSGI-INF/video-workmanager-config.xml Override

<extension point="queues" target="org.nuxeo.ecm.core.work.service">
    <queue id="common">
      <name>Common Shared Queue for Nuxeo Works</name>
      <maxThreads>4</maxThreads>
      <category>aceStatusUpdatedListener</category>
      <category>binary_metadata_work</category>
      <category>blobManagerDeleteMarkedBlobsListener</category>
      <category>checkedInCommentListener</category>
      <category>cleanOpenTasksOnWorkflowDone</category>
      <category>ConversionWork</category>
      <category>CounterListener</category>
      <category>deleteRoutingTaskListener</category>
      <category>docRemovedCommentListener</category>
      <category>documenttemplate-type-binding</category>
      <category>findRetentionExpired</category>
      <category>fulltextExtractor</category>
      <category>notificationListener</category>
      <category>nuxeoDriveGroupUpdateListener</category>
      <category>nuxeoDriveVirtualEventLoggerListener</category>
      <category>opchainpclistener</category>
      <category>orphanVersionRemoverListener</category>
      <category>permissionNotificationListener</category>
      <category>removeDocumentRoutesForDeletedDocument</category>
      <category>removeTasksForDeletedDocumentRoute</category>
      <category>storedRenditionsCleanup</category>
      <category>taggedVersionListener</category>
      <category>triggerEsclationRules</category>
      <category>unicityListener</category>
      <category>UserProfileImporterWork</category>
      <category>wopiDiscoveryRefreshListener</category>
      <category>wopiLocksExpiration</category>
      <category>workflowInstancesCleanup</category>
    </queue>
    <queue id="updateThumbListener">
      <maxThreads>4</maxThreads>
      <category>updateThumbListener</category>
    </queue>
    <queue id="raclupdate">
      <name>Queue for DBS Read ACL update Works</name>
      <maxThreads>4</maxThreads>
      <category>security</category>
    </queue>
    <queue id="pictureViewsGeneration">
      <maxThreads>2</maxThreads>
      <category>pictureViewsGenerationListener</category>
      <category>pictureViewsGeneration</category>
    </queue>
    <queue id="videoConversion">
      <maxThreads>2</maxThreads>
      <category>videoConversion</category>
      <category>videoInfo</category>
      <category>videoStoryboard</category>
    </queue>
  </extension>

(14) nuxeo-runtime-2023.12.6.jar/opt/nuxeo/server/nxserver/config/workmanager-queue-config.xml Override

<extension point="queues" target="org.nuxeo.ecm.core.work.service">
    <queue id="quota">
      <maxThreads>1</maxThreads>
      <category>quotaInitialStatistics</category>
      <category>quotaMaxSizeSetter</category>
      <name>quota</name>
    </queue>
  </extension>

(15) nuxeo-quota-2023.12.6.jar/OSGI-INF/quota-work-contrib.xml Override

<extension point="queues" target="org.nuxeo.ecm.core.work.service">
    <queue id="escalation">
      <category>routingEscalation</category>
      <name>escalation</name>
    </queue>
  </extension>

(16) nuxeo-routing-core-2023.12.6.jar/OSGI-INF/document-routing-escalation-work-contrib.xml Override